home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d26 / qmtek601.arc / QWHITE.TEC < prev    next >
Text File  |  1991-05-23  |  17KB  |  375 lines

  1. ID:QW Quarterdeck White Papers
  2. Quarterdeck Technical Note
  3. by Daniel Travison
  4.  
  5.   Welcome aboard the Quarterdeck White Papers! The White Papers
  6. originated as separate documents prepared by our Technical
  7. Support Staff.  Each one explores a single topic of importance to
  8. users of Quarterdeck products.  They were originally written as
  9. independent items in response to inquires by our users.  Previous
  10. versions have been distributed by mail and FAX as one avenue of 
  11. supporting our customers.
  12.  
  13.   Over a period of time these papers tend to change; there are
  14. additions and deletions all the time as products evolve.  Rather
  15. than distribute a paper version, we hope you will enjoy our
  16. diskette version, which respects the environment.
  17.  
  18.   The Quarterdeck White Papers program (QWHITE.COM) is a
  19. DESQview-specific program for viewing these technical notes
  20. within DESQview.  QWHITE.COM is NOT designed to replace your
  21. favorite file viewing utilities.  It is written specifically to
  22. provide quick access to Quarterdeck's technical notes or your
  23. own, using an interface similar to DESQview's Open Window menu.
  24.  
  25. Using DESQview's Add A Program:
  26.  
  27.    > Place all of the technical notes and QWHITE programs in the  
  28.      same subdirectory.  This is normally done by the install     
  29.      program.
  30.  
  31.    > Select Open Window from the DESQview menu
  32.  
  33.    > Select Add A Program from the Open Window Menu.
  34.  
  35.    > Select 'Other (Add Program Not in List)' by pressing the O   
  36.      key or by clicking on the selection with the mouse.
  37.  
  38.    > Type the drive and subdirectory where QWHITE.COM is located  
  39.      in the path field.  For Example: If you have installed the   
  40.      Quarterdeck White Papers to the subdirectory QWHITE on the C 
  41.      drive, type in the following and press the enter key:
  42.  
  43.           C:\QWHITE
  44.  
  45.    > An entry, 'Quarterdeck White,' will be displayed.  Move the  
  46.      cursor to this entry, press the space bar, then press enter. 
  47.      The Quarterdeck White Papers program is configured to use QW 
  48.      as the keys to use on the open window menu.  If QW is        
  49.      already in use, you will be prompted to provide a different  
  50.      two-key combination.
  51.  
  52.  
  53.  
  54.  
  55. Change A Program:
  56.  
  57.      Conventional Memory: 95k
  58.      System Memory:       20k
  59.  
  60.   QWHITE.COM requires 95k to run.  If you have expanded memory
  61. available, QWHITE.COM will automatically load the technical note
  62. into expanded memory, reducing its conventional memory overhead
  63. to 31k.  This allows you to set the Memory Size field in Change A
  64. Program to 31.  QWHITE.COM will automatically notify you if it
  65. cannot allocate enough memory to run correctly.
  66.  
  67.   QWHITE.COM also requires about 20k of System Memory to function
  68. correctly.  System memory is a block of memory DESQview allocates
  69. on behalf of a program that uses DESQview's Applications
  70. Programming Interface (API).  This memory is used to store some
  71. of the program's DESQview-specific data.  For example, when you
  72. select HELP for the program, the help screen is stored in system
  73. memory.
  74.  
  75.   The System Memory field is found on the Advanced Options screen
  76. of Change A Program.  DESQview will notify you if it runs out of
  77. system memory for the program at any point.  If you receive an
  78. error message from DESQview indicating there is insufficient
  79. system memory for the program, increase the System Memory field
  80. by 1 and run the program again.  Maximum Height: QWHITE detects
  81. the value you specify for MAXIMUM HEIGHT Change A Program to
  82. determine the number of lines to use for the file view window. 
  83. If you run DESQview in 43,50, or 60 line mode you can have QWHITE
  84. use the entire physical screen by specifing an appropriate
  85. starting HEIGHT.  QWHITE also will adjust the number of lines it
  86. uses for PgDn or PgUp when you have used DESQview's resize
  87. option.
  88.  
  89. The Main Menu:
  90.  
  91.   The main menu contains 5 selections:
  92.  
  93.   Open Technote: Displays a menu of technical notes in a format
  94. similar to DESQview's Open window menu.  This menu can contain up
  95. to 256 entries.
  96.  
  97.   Search Technote: Allows searching all technotes for a character
  98. string.
  99.  
  100.   Create New Open Menu: Tells QWHITE.COM to scan all files in the
  101. current directory for files that contain a specific header
  102. record.
  103.  
  104.   Help: Displays a help screen describing each menu option.
  105.  
  106.   Quit: Allows quitting the Quarterdeck White Papers.
  107.  
  108. Getting Help:
  109.   QWHITE.COM has two methods for obtaining help.  The first uses
  110. DESQview's help system.  Normally, when you bring up the DESQview
  111. menu you see an option called 'Help for DESQview'.  When you
  112. bring up the DESQview menu while QWHITE.COM is the foreground
  113. program, you will see an entry 'Help For Program'.  You may press
  114. the ? key at this point to activate QWHITE.COM's help. 
  115. Additionally, you can press the ? key from most screens to
  116. display help specific to the screen.
  117.  
  118. Open Technote:
  119.  
  120.   The Open Technote menu option provides a menu of technical
  121. notes in a manner similar to DESQview's Open Window menu. 
  122. However, instead of opening a window to run a program, this
  123. option allows you to open a window to read a technote.
  124.  
  125.   To read a technote, highlight the entry with the mouse and
  126. click either mouse button, -or- highlight the entry with the Up
  127. and Down cursor keys and press the spacebar, -or- type the two
  128. letters to the right of the entry.  If two or more entries
  129. displayed have the same two-letter combination, you will need to
  130. select the second, third, etc.  entry with the mouse or cursor
  131. keys.  The PgDn and PgUp keys are used to display the entries on
  132. other screens.
  133.  
  134. Two-key limitations:
  135.  
  136.   QWHITE.COM will only accept files that use the letters A
  137. through Z and the numbers 0 through 9 for the two-key combination
  138. when building the Open Technote list.  QWHITE.COM will allow you
  139. to specify the same two-key sequences in more than one technical
  140. note.  Although this allows some flexibility, it does provide
  141. certain limitations for the Open Technote menu.  Here is a
  142. description of how QWHITE.COM decides which technote to view when
  143. you select a two-key combination that appears two or more times
  144. in the Open Technote list:
  145.  
  146.    a) When the first key is pressed, QWHITE.COM searches its
  147. internal list for any entries that start with the key.  If none
  148. are found, you will hear a beep and the key will be ignored.
  149.  
  150.    b) When the second key is press QWHITE.COM starts with the
  151. first entry on the current Open Technote screen when searching
  152. for a matching two-key selection.
  153.  
  154.    c) If the two-key combination you type is on the screen,
  155. QWHITE.COM will open that technote.
  156.  
  157.    d) If the two-key combination is not on the current screen,
  158. QWHITE.COM will search to the end of the Open Technote list to
  159. find an entry that matches.  If none is found, it will go back to
  160. the top of the list and search from there until if finds a valid
  161. entry and opens it.  If none are found, you will here a beep when
  162. you press the second key.
  163.    e) If two or more entries with the same two-key combination
  164. appear on the same screen, QWHITE.COM will ALWAYS open the first. 
  165. You will need to select the second (third, fourth, etc) manually
  166. by using the cursor keys to highlight the entry and pressing
  167. enter -or- by clicking on it with the left mouse button.
  168.  
  169. Search Technotes:
  170.  
  171.  The Search Technotes option allows scanning all technical notes
  172. on the Open Technote menu for the character string you specify. 
  173. It is not case sensitive and it will also ignore trailing spaces
  174. when scanning the files.  The START SEARCH option ALWAYS starts
  175. with the first entry in your Open Technote list.  After a match
  176. has been found two additional options will be available:
  177. "Continue Current File F2" and "Continue Next File F3".  The
  178. "Continue Current File" option continues searching from the point
  179. of the last successful match.  The "Continue Next File" option
  180. skips the file where the last match occured and starts searching
  181. the next file.  This option is useful when you have a search
  182. string that occurs more than one time in the same file and you
  183. want to go on to other files.  If any of the above search options
  184. reach the last entry in the Open Technote list the Continue
  185. Search options will be disabled.  If any of the search options
  186. find a match, the file will be loaded into the list window.  The
  187. page that contains the match will be displayed and the line that
  188. contains the match will he highlighted.  If you select either of
  189. the Continue Search options and no match is found, the last file
  190. containing a match will be reloaded and positioned to the line
  191. you had last viewed.
  192.  
  193. Create new Open menu: Adding new technical notes to the Open
  194. Technote menu
  195.  
  196.   The Create new Open menu searches all files in its directory
  197. for files that have a specific ID line at the beginning of the
  198. file (NOTE: See Technical Note Header).  The file should be
  199. normal ASCII files without special control codes in it.  Your
  200. editor or word processor may refer to it as Non-Document, Text,
  201. or ASCII files.  See the notes on Technical Note File Types.
  202.  
  203.   Your own technical notes may be added to the Open Technote menu
  204. by inserting an ID line at the beginning of the file.  Your file
  205. should be copied to the directory where QWHITE.COM is located and
  206. the Create option should be selected from the menu.
  207.  
  208.   QWHITE.COM can only display 256 options on the Open Technote
  209. menu at a time.  If you have more than 256 files you will need to
  210. create a second subdirectory and divide your technical notes
  211. between the two subdirectories and place a copy of QWHITE.COM in
  212. each.  Run DESQview's Change a Program and modify the Directory
  213. field to point to the new subdirectory and change the 'Keys to
  214. Use on Open Menu' create a second entry for the new subdirectory.
  215.  
  216. Technical Note Header: Example: See the first line of this file
  217.   QWHITE.COM checks the first line of a file for a specific
  218. character sequence to identify the file as a technical note for
  219. including in the Open Technote menu.  The first three characters
  220. should be 'ID:' (NOTE: the single quotes should not be not
  221. included).  The next two characters are the two keys used on the
  222. Open Technote menu.  This is similar to DESQview's own Open
  223. Window menu except QWHITE.COM allows duplicates.  The next
  224. character MUST be a space.  Finally, the next 35 characters will
  225. be used on the Open Technote menu to describe the file, much as
  226. the Program Name field of Change A Program is used to identify
  227. the entry on DESQview's Open Window Menu.  Also, it is not
  228. necessary to provide all 35 characters, QWHITE.COM will
  229. automatically stop if it finds a linefeed character.
  230.  
  231. Technical Note File Types:
  232.  
  233.   QWHITE.COM will attempt to display ANY file that contains a
  234. valid header.  However, for best results you should use an editor
  235. or word processor that can create normal ASCII format files. 
  236. Your editor/word processor may refer to this type of file as
  237. NON-DOCUMENT, ASCII, TEXT, or some similar name.
  238.  
  239.   QWHITE.COM processes the following control codes, all others
  240. are ignored and not displayed.
  241.  
  242.   LINEFEED - indicates the end of a line.  If you experience
  243. trouble viewing your document, make sure your word processor is
  244. creating a TEXT file instead of its own DOCUMENT file format.
  245.  
  246.   TAB - moves the 'cursor' 8 positions before printing the next
  247. character.  This is a non-standard method of displaying the TAB
  248. character.  It is designed to allow you to compress a file that
  249. is 'slightly' larger than 64k by replacing sequences of 8 blanks
  250. with a tab character.
  251.  
  252.   END OF FILE - indicates the end of the file.  If no END OF FILE
  253. marker is found, the physical file size will be used.
  254.  
  255.   OTHERS - All other control codes will be ignored and not
  256. displayed.
  257.  
  258.   Additionally, QWHITE.COM will display a maximum of 78
  259. characters/line and drop any characters found after that
  260. position.
  261.  
  262. Reading Technical Notes:
  263.  
  264.   The view mode of QWHITE.COM provides a simple interface for
  265. reading a technical note.  The following keys are active when
  266. reading a technote:
  267.  
  268.                 P      Print
  269.  
  270.                 Up     Scroll up
  271.                 Down   Scroll down
  272.  
  273.                 PgUp   Previous page
  274.  
  275.                 PgDn   Next page
  276.  
  277.                 Home   Top of the file
  278.  
  279.                 End    End of file
  280.  
  281.                 Esc    Exit window
  282.  
  283.             *   F2     Continue Current File
  284.  
  285.             *   F3     Continue Next File
  286.  
  287.   * The F2 and F3 keys are invisible options.  These options are
  288. available only when the search option displays a file.  It allows
  289. you to select either Continue Search option without having to
  290. return to the Search menu.
  291.  
  292. File Size limits: 64k
  293.  
  294.   QWHITE.COM will not display files that are larger than 64k. 
  295. Since the technical documents are written to answer specific
  296. questions or solve specific problems, by nature they should be
  297. concise and we have found they often fit on a single sheet of
  298. paper.  The 64k limit we choose is merely a convenience from a
  299. programming standpoint.  In actuality, 64k is generally too large
  300. for a technical note.  See the note on TAB in the section
  301. discussing Control Codes above for a file that exceeds 64k.
  302.  
  303. Printing:
  304.  
  305.   The List window provides the option for printing a technical
  306. note.  This option is here for those times when you want to
  307. quickly print the technical note you are viewing.  If you have
  308. need for extensive printing or printer specific options, you may
  309. want to open a separate window and perform your printing from
  310. there.  When you select the Print field or press the letter P, a
  311. window will pop up indicating the name of the file that will be
  312. printed.  You may press Esc at this time to cancel the request or
  313. Enter to start printing.  A running total of lines printed will
  314. be displayed as the file prints.  You may press Enter or Escape
  315. while the file is being printed to abort the print.  QWHITE.COM
  316. will send a formfeed character at this point, or when it finishes
  317. printing the file to the printer and returns you to the list
  318. window.  QWHITE.COM prints to the standard printer device.  In
  319. other words, whatever printer is currently assigned to PRN will
  320. be used by QWHITE.COM.  This will allow your print spooler loaded
  321. before DESQview to capture the output from the White Papers.
  322.  
  323. Printer Setup:
  324.  
  325.   QWHITE.COM does not attempt to perform any printer setup
  326. commands.  If you wish to have the printer set up a particular
  327. way, you have two options:
  328.  
  329.   1: Many printers provide setup capabilities from a control
  330. panel on the printer.  If you use this method, do so before
  331. selecting Print from the list screen.
  332.  
  333.   2: There are numerous utilities available that allow the user
  334. to set up the printer from software.  If you have DESQview
  335. configured to manage printer contention, you may need to run your
  336. utility prior to running the White Papers.  If you do not have
  337. DESQview configured to manage printer contention, you can open
  338. another window and run the utility prior to selecting the Print
  339. option from QWHITE.COM's list screen.
  340.  
  341. Using the Quarterdeck White Papers on a Network:
  342.  
  343.   QWHITE.COM does not make network specific calls.  If multiple
  344. users will be running QWHITE.COM from a network drive, the
  345. network administrator will need to establish some constraints for
  346. file access:
  347.  
  348.   a: Generally, only ONE user should have create rights to the
  349. file QWHITE.WPO.  All other users should have read-only access. 
  350. QWHITE.COM checks the read-only file attribute on startup and
  351. will disable the Create New Open Menu option for users with this
  352. file attribute set.  When a new technical note is added to the
  353. directory QWHITE.COM is run from, the user with create rights
  354. should choose the Create New Open Menu option to generate a new
  355. QWHITE.WPO file.  Other users can then restart the program to see
  356. the new Open Technote entry.
  357.  
  358.   b: Users that do not have the read-only attribute set for
  359. QWHITE.WPO and also do NOT have create rights will be able to
  360. select the create option.  QWHITE will scan the files and create
  361. the Open Technote menu in memory but will generate an error
  362. message when it attempts to write the file to disk.
  363.  
  364.   c: QWHITE.COM attempts to open technote files in read-only
  365. mode.  If the file has been locked by a user then QWHITE.COM will
  366. not be able to display the file.  Some word processors and file
  367. viewing utilities disable read access to files being edited. 
  368. Technical notes are loaded completely into memory when selected
  369. and closed immediately.  These files are not left open.
  370.  
  371.   d: QWHITE.COM loads QWHITE.WPO at startup and then closes the
  372. file.  It does not leave the file open after it has been loaded.
  373.  
  374.        Copyright (C) 1991 by Quarterdeck Office Systems
  375.               * * * E N D  O F  F I L E * * *